<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>AdWords API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link></head><body><div id="content"><h1 class="file">AdWords/Util/ReportUtils.php</h1><div id="file-nav-box"><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img>
                          Classes
                      </a><ul><li><a href="#\DateRange">\DateRange</a></li><li><a href="#\DownloadFormat">\DownloadFormat</a></li><li><a href="#\OrderBy">\OrderBy</a></li><li><a href="#\Paging">\Paging</a></li><li><a href="#\Predicate">\Predicate</a></li><li><a href="#\PredicateOperator">\PredicateOperator</a></li><li><a href="#\ReportDefinition">\ReportDefinition</a></li><li><a href="#\ReportDefinitionDateRangeType">\ReportDefinitionDateRangeType</a></li><li><a href="#\ReportDefinitionReportType">\ReportDefinitionReportType</a></li><li><a href="#\ReportDownloadException">\ReportDownloadException</a></li><li><a href="#\ReportUtils">\ReportUtils</a></li><li><a href="#\Selector">\Selector</a></li><li><a href="#\SortOrder">\SortOrder</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab">
              Table of Contents
          </div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">A collection of utility methods for working with reports.</div><div class="long-description"><p>PHP version 5</p>

<p>Copyright 2011, Google Inc. All Rights Reserved.</p>

<p>Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at</p>

<pre><code>http://www.apache.org/licenses/LICENSE-2.0
</code></pre>

<p>Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</p></div></div><dl class="file-info"><dt>Author</dt><dd>Eric Koleda
         
    </dd><dt>Author</dt><dd>Vincent Tsao
         
    </dd><dt>Category</dt><dd>WebServices
         
    </dd><dt>Copyright</dt><dd>2011, Google Inc. All Rights Reserved.
         
    </dd><dt>License</dt><dd>http://www.apache.org/licenses/LICENSE-2.0 Apache License,
            Version 2.0
         
    </dd><dt>Package</dt><dd>GoogleApiAdsAdWords
         
    </dd><dt>Subpackage</dt><dd>Util
         
    </dd></dl><a name="classes" class="anchor"></a><a id="\DateRange" class="anchor"></a><h2 class="class">\DateRange<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Represents a range of dates that has either an upper or a lower bound.</div><div class="long-description"><p>The format for the date is YYYYMMDD.</p></div><dl class="class-info"></dl><h3>Properties</h3><div><a id="\DateRange::$max" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>string <span class="highlight">$max</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\DateRange::$min" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>string <span class="highlight">$min</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\DateRange::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">( $min = NULL,  $max = NULL)</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$min</th><td></td><td><em></em></td></tr><tr><th>$max</th><td></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\DateRange::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\DateRange::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\DownloadFormat" class="anchor"></a><h2 class="class">\DownloadFormat<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Enum class that describes the supported formats for content downloads.</div><div class="long-description"><p>The order mimics the order in which download options are presented in the
legacy report center.</p></div><dl class="class-info"></dl><h3>Methods</h3><div><a id="\DownloadFormat::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\DownloadFormat::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\DownloadFormat::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\OrderBy" class="anchor"></a><h2 class="class">\OrderBy<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Specifies how the resulting information should be sorted.</div><div class="long-description"></div><dl class="class-info"></dl><h3>Properties</h3><div><a id="\OrderBy::$field" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>string <span class="highlight">$field</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\OrderBy::$sortOrder" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\tnsSortOrder <span class="highlight">$sortOrder</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>\tnsSortOrder</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\OrderBy::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">( $field = NULL,  $sortOrder = NULL)</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$field</th><td></td><td><em></em></td></tr><tr><th>$sortOrder</th><td></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\OrderBy::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\OrderBy::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\Paging" class="anchor"></a><h2 class="class">\Paging<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Specifies the page of results to return in the response.</div><div class="long-description"><p>A page is specified
by the result position to start at and the maximum number of results to
return.</p></div><dl class="class-info"></dl><h3>Properties</h3><div><a id="\Paging::$numberResults" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>integer <span class="highlight">$numberResults</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>integer</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\Paging::$startIndex" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>integer <span class="highlight">$startIndex</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>integer</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Paging::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">( $startIndex = NULL,  $numberResults = NULL)</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$startIndex</th><td></td><td><em></em></td></tr><tr><th>$numberResults</th><td></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Paging::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\Paging::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\Predicate" class="anchor"></a><h2 class="class">\Predicate<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Specifies how an entity (eg.</div><div class="long-description"><p>adgroup, campaign, criterion, ad) should be filtered.</p></div><dl class="class-info"></dl><h3>Properties</h3><div><a id="\Predicate::$field" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>string <span class="highlight">$field</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\Predicate::$operator" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\tnsPredicateOperator <span class="highlight">$operator</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>\tnsPredicateOperator</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\Predicate::$values" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>string[] <span class="highlight">$values</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string[]</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Predicate::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">( $field = NULL,  $operator = NULL,  $values = NULL)</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$field</th><td></td><td><em></em></td></tr><tr><th>$operator</th><td></td><td><em></em></td></tr><tr><th>$values</th><td></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Predicate::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\Predicate::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\PredicateOperator" class="anchor"></a><h2 class="class">\PredicateOperator<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Defines the valid set of operators.</div><div class="long-description"></div><dl class="class-info"></dl><h3>Methods</h3><div><a id="\PredicateOperator::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\PredicateOperator::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\PredicateOperator::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\ReportDefinition" class="anchor"></a><h2 class="class">\ReportDefinition<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Represents a report definition.</div><div class="long-description"></div><dl class="class-info"></dl><h3>Properties</h3><div><a id="\ReportDefinition::$creationTime" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>string <span class="highlight">$creationTime</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportDefinition::$dateRangeType" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\tnsReportDefinitionDateRangeType <span class="highlight">$dateRangeType</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>\tnsReportDefinitionDateRangeType</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportDefinition::$downloadFormat" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\tnsDownloadFormat <span class="highlight">$downloadFormat</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>\tnsDownloadFormat</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportDefinition::$hasAttachment" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>boolean <span class="highlight">$hasAttachment</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportDefinition::$id" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>integer <span class="highlight">$id</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>integer</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportDefinition::$includeZeroImpressions" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>boolean <span class="highlight">$includeZeroImpressions</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportDefinition::$reportName" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>string <span class="highlight">$reportName</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportDefinition::$reportType" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\tnsReportDefinitionReportType <span class="highlight">$reportType</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>\tnsReportDefinitionReportType</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportDefinition::$selector" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\Selector <span class="highlight">$selector</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/AdWords.Util.ReportUtils.html#\Selector">\Selector</a></dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\ReportDefinition::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">( $id = NULL,  $selector = NULL,  $reportName = NULL,  $reportType = NULL,  $hasAttachment = NULL,  $dateRangeType = NULL,  $downloadFormat = NULL,  $creationTime = NULL,  $includeZeroImpressions = NULL)</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$id</th><td></td><td><em></em></td></tr><tr><th>$selector</th><td></td><td><em></em></td></tr><tr><th>$reportName</th><td></td><td><em></em></td></tr><tr><th>$reportType</th><td></td><td><em></em></td></tr><tr><th>$hasAttachment</th><td></td><td><em></em></td></tr><tr><th>$dateRangeType</th><td></td><td><em></em></td></tr><tr><th>$downloadFormat</th><td></td><td><em></em></td></tr><tr><th>$creationTime</th><td></td><td><em></em></td></tr><tr><th>$includeZeroImpressions</th><td></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\ReportDefinition::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\ReportDefinition::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\ReportDefinitionDateRangeType" class="anchor"></a><h2 class="class">\ReportDefinitionDateRangeType<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Enums for date range of report.</div><div class="long-description"></div><dl class="class-info"></dl><h3>Methods</h3><div><a id="\ReportDefinitionDateRangeType::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\ReportDefinitionDateRangeType::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\ReportDefinitionDateRangeType::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\ReportDefinitionReportType" class="anchor"></a><h2 class="class">\ReportDefinitionReportType<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Enums for report types.</div><div class="long-description"></div><dl class="class-info"></dl><h3>Methods</h3><div><a id="\ReportDefinitionReportType::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\ReportDefinitionReportType::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\ReportDefinitionReportType::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\ReportDownloadException" class="anchor"></a><h2 class="class">\ReportDownloadException<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Exception class for an error that occurs while downloading a report.</div><div class="long-description"></div><dl class="class-info"><dt>Parent(s)</dt><dd><a href="../files/http://php.net/manual/en/class.exception.php">\Exception</a></dd></dl><h3>Methods</h3><div><a id="\ReportDownloadException::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">(string $error = NULL, string $httpCode = NULL)</span> : void</code><div class="description"><p class="short_description">Constructor for ReportDownloadException.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$error</th><td>string</td><td><em><p>an optional error message</p></em></td></tr><tr><th>$httpCode</th><td>string</td><td><em><p>an optional HTTP status code of the response</p></em></td></tr></table></div><div class="clear"></div></div></div></div><a id="\ReportUtils" class="anchor"></a><h2 class="class">\ReportUtils<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">A collection of utility methods for working with reports.</div><div class="long-description"></div><dl class="class-info"></dl><h3>Constants</h3><div><a id="\ReportUtils::CLIENT_LOGIN_FORMAT" class="anchor"></a><div class="constant publicC"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/constant.png" alt="Constant"></img> 
                <span class="highlight">CLIENT_LOGIN_FORMAT</span>
                = 'GoogleLogin auth=%s'</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div></div><h3>Properties</h3><div><a id="\ReportUtils::$DOWNLOAD_URL_FORMAT" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$DOWNLOAD_URL_FORMAT</span> = '%s/api/adwords/reportdownload/%s'</code><div class="description"><span class="attribute">static</span><div class="short-description">The format of the report download URL, for use with sprintf.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>'%s/api/adwords/reportdownload/%s'</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Access</dt><dd>private
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportUtils::$ERROR_MESSAGE_REGEX" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$ERROR_MESSAGE_REGEX</span> = '/^!!![^|]*\|\|\|([^|]*)\|\|\|([^?]*)\?\?\?/'</code><div class="description"><span class="attribute">static</span><div class="short-description">Regular expression used to detect errors messages in a response.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>'/^!!![^|]*\|\|\|([^|]*)\|\|\|([^?]*)\?\?\?/'</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Access</dt><dd>private
         
    </dd></dl></div><div class="clear"></div></div><a id="\ReportUtils::$LOG_NAME" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">$LOG_NAME</span> = 'report_download'</code><div class="description"><span class="attribute">static</span><div class="short-description">The log name to use when logging requests.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>'report_download'</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\ReportUtils::$SNIPPET_LENGTH" class="anchor"></a><div class="property private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">$SNIPPET_LENGTH</span> = 1024</code><div class="description"><span class="attribute">static</span><div class="short-description">The length of the snippet to read from the request to determine if there
was an error.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>1024</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Access</dt><dd>private
         
    </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\ReportUtils::DownloadReport()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">DownloadReport</span><span class="nb-faded-text">(mixed $reportDefinition, string $path = NULL, <a href="../files/AdWords.Lib.AdWordsUser.html#\AdWordsUser">\AdWordsUser</a> $user, array $options = NULL)</span> : mixed</code><div class="description"><span class="attribute">static</span><p class="short_description">Downloads a new instance of an existing report definition.</p></div><div class="code-tabs"><div class="long-description"><p>If the path
parameter is specified it will be downloaded to the file at that path,
otherwise it will be downloaded to memory and be returned as a string.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$reportDefinition</th><td>mixed</td><td><em><p>the ReportDefinition to download or the id
    of a stored report definition</p></em></td></tr><tr><th>$path</th><td>string</td><td><em><p>an optional path of the file to download the report to</p></em></td></tr><tr><th>$user</th><td><a href="../files/AdWords.Lib.AdWordsUser.html#\AdWordsUser">\AdWordsUser</a></td><td><em><p>the user that created the ReportDefinition</p></em></td></tr><tr><th>$options</th><td>array</td><td><em><p>the option to use when downloading the report:
    {boolean} returnMoneyInMicros: if the money values in the report
        should be returned in micros
    {string} server: the server to make the request to. If <var>NULL</var>,
        then the default server will be used
    {string} version: the version to make the request against. If
        <var>NULL</var>, then the default version will be used</p>
</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td>if path isn't specified the contents of the report,
    otherwise the size in bytes of the downloaded report</td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::DownloadReportFromUrl()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">DownloadReportFromUrl</span><span class="nb-faded-text">(string $url, array $headers, array $params, string $path = NULL)</span> : mixed</code><div class="description"><span class="attribute">static</span><p class="short_description">Downloads a report using the URL provided.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$url</th><td>string</td><td><em><p>the URL to make the request to</p></em></td></tr><tr><th>$headers</th><td>array</td><td><em><p>the headers to use in the request</p></em></td></tr><tr><th>$params</th><td>array</td><td><em><p>the parameters to pass in the request</p></em></td></tr><tr><th>$path</th><td>string</td><td><em><p>the optional path to download the report to</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td>if path isn't specified the contents of the report,
    otherwise the size in bytes of the downloaded report</td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::DownloadReportWithAwql()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">DownloadReportWithAwql</span><span class="nb-faded-text">(string $reportQuery, string $path = NULL, <a href="../files/AdWords.Lib.AdWordsUser.html#\AdWordsUser">\AdWordsUser</a> $user,  $reportFormat, array $options = NULL)</span> : mixed</code><div class="description"><span class="attribute">static</span><p class="short_description">Downloads a report with AWQL.</p></div><div class="code-tabs"><div class="long-description"><p>If the path parameter is specified it will be
downloaded to the file at that path, otherwise it will be downloaded to
memory and be returned as a string.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$reportQuery</th><td>string</td><td><em><p>the query to use for the report</p></em></td></tr><tr><th>$path</th><td>string</td><td><em><p>an optional path of the file to download the report to</p></em></td></tr><tr><th>$user</th><td><a href="../files/AdWords.Lib.AdWordsUser.html#\AdWordsUser">\AdWordsUser</a></td><td><em><p>the user to retrieve report with</p></em></td></tr><tr><th>$reportFormat</th><td></td><td><em></em></td></tr><tr><th>$options</th><td>array</td><td><em><p>the option to use when downloading the report:
    {string} server: the server to make the request to. If <var>NULL</var>,
        then the default server will be used
    {string} version: the version to make the request against. If
        <var>NULL</var>, then the default version will be used</p>
</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td>if path isn't specified the contents of the report,
    otherwise the size in bytes of the downloaded report</td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::GetHeaders()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">GetHeaders</span><span class="nb-faded-text">(<a href="../files/AdWords.Lib.AdWordsUser.html#\AdWordsUser">\AdWordsUser</a> $user, string $url, array $options = NULL)</span> : array</code><div class="description"><span class="attribute">static</span><p class="short_description">Gets the HTTP headers for the report download request.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$user</th><td><a href="../files/AdWords.Lib.AdWordsUser.html#\AdWordsUser">\AdWordsUser</a></td><td><em><p>the AdWordsUser to get credentials from</p></em></td></tr><tr><th>$url</th><td>string</td><td><em><p>the URL the request will be made to</p></em></td></tr><tr><th>$options</th><td>array</td><td><em><p>the options for the download</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>and array of strings, which are header names and values</td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::GetParams()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">GetParams</span><span class="nb-faded-text">(mixed $reportDefinition)</span> : array</code><div class="description"><span class="attribute">static</span><p class="short_description">Generates the parameters to use for the download request.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$reportDefinition</th><td>mixed</td><td><em><p>the report definition, as an ID or object</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>the parameters</td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::GetQueryParams()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">GetQueryParams</span><span class="nb-faded-text">(string $reportQuery, string $reportFormat)</span> : array</code><div class="description"><span class="attribute">static</span><p class="short_description">Generates the parameters to use for the download request with AWQL.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$reportQuery</th><td>string</td><td><em><p>the report query, as string</p></em></td></tr><tr><th>$reportFormat</th><td>string</td><td><em><p>the format to request report in, as string</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>the parameters</td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::GetUrl()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">GetUrl</span><span class="nb-faded-text">(<a href="../files/AdWords.Lib.AdWordsUser.html#\AdWordsUser">\AdWordsUser</a> $user, array $options = NULL)</span> : string</code><div class="description"><span class="attribute">static</span><p class="short_description">Generates the URL to use for the download request.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$user</th><td><a href="../files/AdWords.Lib.AdWordsUser.html#\AdWordsUser">\AdWordsUser</a></td><td><em><p>the AdWordsUser to make the request for</p></em></td></tr><tr><th>$options</th><td>array</td><td><em><p>the options configured for the download</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td>the download URL</td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::LogRequest()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">LogRequest</span><span class="nb-faded-text">(string $requestHeaders, integer $responseCode, array $params = NULL, <a href="../files/http://php.net/manual/en/class.exception.php">\Exception</a> $exception = NULL)</span> : void</code><div class="description"><span class="attribute">static</span><p class="short_description">Logs the report download request.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$requestHeaders</th><td>string</td><td><em><p>the HTTP request headers</p></em></td></tr><tr><th>$responseCode</th><td>integer</td><td><em><p>the HTTP response code</p></em></td></tr><tr><th>$params</th><td>array</td><td><em><p>the parameters that were sent, if any</p></em></td></tr><tr><th>$exception</th><td><a href="../files/http://php.net/manual/en/class.exception.php">\Exception</a></td><td><em><p>the exception that will be thrown, if any</p></em></td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::ParseApiErrorXml()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">ParseApiErrorXml</span><span class="nb-faded-text">(String $responseXml)</span> : Object</code><div class="description"><span class="attribute">static</span><p class="short_description">Tries to parse the error response xml from the AdWords API server as an
object.</p></div><div class="code-tabs"><div class="long-description"><p>This method is used in parsing all error responses when API
version >= v201209, and in other versions when apiMode header is mentioned
in the request headers.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$responseXml</th><td>String</td><td><em><p>the error response xml</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>Object</td><td>the parsed error object, or null if the response cannot
be parsed.</td></tr></table></div><div class="clear"></div></div><a id="\ReportUtils::__construct()" class="anchor"></a><div class="method private"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img><span class="highlight">__construct</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description">The ReportUtils class is not meant to have any instances.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="function-info"><dt>Access</dt><dd>private
         
    </dd></dl></div><div class="clear"></div></div></div></div><a id="\Selector" class="anchor"></a><h2 class="class">\Selector<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">A generic selector to specify the type of information to return.</div><div class="long-description"></div><dl class="class-info"></dl><h3>Properties</h3><div><a id="\Selector::$dateRange" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\DateRange <span class="highlight">$dateRange</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/AdWords.Util.ReportUtils.html#\DateRange">\DateRange</a></dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\Selector::$fields" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>string[] <span class="highlight">$fields</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string[]</dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\Selector::$ordering" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\OrderBy[] <span class="highlight">$ordering</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/AdWords.Util.ReportUtils.html#\OrderBy">\OrderBy[]</a></dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\Selector::$paging" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\Paging <span class="highlight">$paging</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/AdWords.Util.ReportUtils.html#\Paging">\Paging</a></dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div><a id="\Selector::$predicates" class="anchor"></a><div class="property public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt="&gt;"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img>\Predicate[] <span class="highlight">$predicates</span></code><div class="description"><div class="short-description"></div></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/AdWords.Util.ReportUtils.html#\Predicate">\Predicate[]</a></dd><dt>Access</dt><dd>public
         
    </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Selector::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">( $fields = NULL,  $predicates = NULL,  $dateRange = NULL,  $ordering = NULL,  $paging = NULL)</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$fields</th><td></td><td><em></em></td></tr><tr><th>$predicates</th><td></td><td><em></em></td></tr><tr><th>$dateRange</th><td></td><td><em></em></td></tr><tr><th>$ordering</th><td></td><td><em></em></td></tr><tr><th>$paging</th><td></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Selector::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\Selector::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div><a id="\SortOrder" class="anchor"></a><h2 class="class">\SortOrder<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>GoogleApiAdsAdWords\Util</small><div class="short-description">Possible orders of sorting.</div><div class="long-description"></div><dl class="class-info"></dl><h3>Methods</h3><div><a id="\SortOrder::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description"></p></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\SortOrder::getNamespace()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getNamespace</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the namesapce of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>namespace of this class</td></tr></table></div><div class="clear"></div></div><a id="\SortOrder::getXsiTypeName()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getXsiTypeName</span><span class="nb-faded-text">()</span> : \the</code><div class="description"><p class="short_description">Gets the xsi:type name of this class</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>\the</td><td>xsi:type name of this class</td></tr></table></div><div class="clear"></div></div></div></div></div><small class="footer">
            Documentation was generated by
            <a href="http://phpdoc.org">phpDocumentor
                2.0.0a12</a>.
        </small></body></html>
